# Configuration file for the Sphinx documentation builder.
#
# This file only contains a selection of the most common options. For a full
# list see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html

# -- Path setup --------------------------------------------------------------

import inspect
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#
import os
import sys

# sys.path.insert(0, os.path.abspath('.'))
sys.path.insert(0, os.path.abspath('../../src'))  # 指向src(需要导出用例的目录),不然无法访问模块页

# -- Project information -----------------------------------------------------

project = 'Sphinx-Auto'
copyright = '2024, Zyp'
author = 'Zyp'

# The full version, including alpha/beta/rc tags
release = '2.0'

# -- General configuration ---------------------------------------------------

# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = ['sphinx.ext.autodoc',
              'sphinx.ext.doctest',
              'sphinx.ext.intersphinx',
              # 'sphinx.ext.todo',
              'sphinx.ext.coverage',
              'sphinx.ext.mathjax',
              'sphinx.ext.napoleon',
              'sphinx.ext.viewcode',
              'myst_parser'  # pip install myst-parser
              ]
add_module_names = False
autodoc_member_order = 'alphabetical'  # 'bysource'

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
language = 'zh_CN'

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path.
exclude_patterns = []

# -- Options for HTML output -------------------------------------------------

# The theme to use for HTML and HTML Help pages.  See the documentation for
# a list of builtin themes.
#
# html_theme = 'alabaster'
# import sphinx_rtd_theme    # 需要先pip install sphinx_rtd_theme
# html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
# html_theme = 'furo'  # pip install furo
html_theme = 'sphinx_book_theme'  # pip install sphinx-book-theme

# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']


# -- Options for HTMLHelp output ---------------------------------------------
def skip_member(app, what, name, obj, skip, options):
    if name.startswith("_"):
        print(f"skipped: {name}")
        return True
    if isinstance(obj, type):
        return False
    if inspect.isfunction(obj) or inspect.ismethod(obj) or isinstance(obj, property):
        if not hasattr(obj, '_export_to_docs'):
            print("skipped: ", name)
            return True
    return skip


def setup(app):
    app.connect('autodoc-skip-member', skip_member)
    # 可选：排除特定名称的成员
    app.add_config_value("autodoc_exclude_members", [], True)
